- [About](#org5b12c94)
- [Activate environment](#orgb5291d0)
- [Generating docs](#org1339631)
- [Other helpful documentation](#orgf69d049)



<a id="org5b12c94"></a>

# About

The examples are mostly taken from <https://spk121.github.io/guile-gi/Tutorial.html> or adapted from the examples there.


<a id="orgb5291d0"></a>

# Activate environment

```shell
bash guix-env/env.sh
```


<a id="org1339631"></a>

# Generating docs

One can invoke a command to generate docs for GLib as follows:

```shell
guild gi-gtkdoc --format=html --output=docs --namespace=GLib --version=2.0
```

This will create a directory named `docs`, as specified by the argument `--output=docs`. In that directory there should be an `index.html`, which one can open in a browser. On that page, there should be a link labeled `Functions`. Clicking that link will direct to a page, which describes some functions.


<a id="orgf69d049"></a>

# Other helpful documentation

-   Tutorial for `guile-gi`: <https://spk121.github.io/guile-gi/Tutorial.html>
    -   Example repository: <https://spk121.github.io/guile-gi/Window-with-Button.html>
-   GTK docs: <https://docs.gtk.org/gtk3/index.html>
-   GI Repository docs: <https://spk121.github.io/guile-gi/Typelib-Introspection.html>
